Skip to main content
POST
/
v1
/
log-repositories
/
logs
/
search
Search logs in a log repository
curl --request POST \
  --url https://api.getmaxim.ai/v1/log-repositories/logs/search \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '{
  "workspaceId": "<string>",
  "id": "<string>",
  "type": "session",
  "timestamp": {
    "gte": "<string>",
    "lte": "<string>"
  },
  "sessionId": "<string>",
  "searchQuery": "<string>",
  "traceFilters": {
    "combinator": "all",
    "filters": [
      {
        "columnName": "tags",
        "operator": "equal",
        "value": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  },
  "evaluatorFilters": {
    "combinator": "all",
    "filters": [
      {
        "evaluatorName": "<string>",
        "operator": "null",
        "value": "<any>"
      }
    ]
  },
  "page": 0,
  "limit": 10,
  "sorting": {
    "columnName": "<string>",
    "desc": true
  }
}'
{
  "data": {
    "uniqueTags": [
      "<string>"
    ],
    "logs": [
      {
        "id": "<string>",
        "tags": {},
        "timestamp": "<string>",
        "startTimestamp": "<string>",
        "endTimestamp": "<string>",
        "name": "<string>",
        "feedback": {
          "score": 123,
          "comment": "<string>"
        }
      }
    ]
  },
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

id
string
required

Log repository ID

type
enum<string>
required

Type of logs to retrieve (session or trace)

Available options:
session,
trace
timestamp
object

Timestamp range for filtering logs eg: { gte: '2024-01-01T00:00:00Z', lte: '2024-01-31T23:59:59Z' }

sessionId
string

Filter logs by session ID

searchQuery
string

Search query to filter logs

traceFilters
object

Trace properties to filter on

evaluatorFilters
object

Evaluator metrics to be filtered on

page
number
default:0

Page number for pagination

limit
number
default:10

Number of records per page (max: 100)

Required range: x <= 50
sorting
object

Sorting configuration for logs eg: { id: 'startTimestamp', desc: true }

Response

Logs retrieved successfully

data
object
required
pagination
object
required
I